.TH MPI_Win_get_attr 3 "6/7/2023" " " "MPI"
.SH NAME
MPI_Win_get_attr \-  Get attribute cached on an MPI window object 
.SH SYNOPSIS
.nf
.fi
.nf
int MPI_Win_get_attr(MPI_Win win, int win_keyval, void *attribute_val,
int *flag)
.fi


.SH INPUT PARAMETERS
.PD 0
.TP
.B win 
- window to which the attribute is attached (handle)
.PD 1
.PD 0
.TP
.B win_keyval 
- key value (integer)
.PD 1

.SH OUTPUT PARAMETERS
.PD 0
.TP
.B attribute_val 
- attribute value, unless flag = false (None)
.PD 1
.PD 0
.TP
.B flag 
- false if no attribute is associated with the key (logical)
.PD 1

.SH NOTES
The following attributes are predefined for all MPI Window objects:

.PD 0
.TP
.B MPI_WIN_BASE 
- window base address.
.PD 1
.PD 0
.TP
.B MPI_WIN_SIZE 
- window size, in bytes.
.PD 1
.PD 0
.TP
.B MPI_WIN_DISP_UNIT 
- displacement unit associated with the window.
.PD 1

Attributes must be extracted from the same language as they were inserted
in with 
.I MPI_ATTR_PUT
\&.
The notes for C and Fortran below explain why.

.SH THREAD AND INTERRUPT SAFETY

This routine is thread-safe.  This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks.  However, the routine is not interrupt safe.  Typically,
this is due to the use of memory allocation routines such as 
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.

.SH NOTES FOR C
Even though the 
.I attribute_val
argument is declared as 
.I void *
, it is
really the address of a void pointer (i.e., a 
.I void **
).  Using
a 
.I void *
, however, is more in keeping with C idiom and allows the
pointer to be passed without additional casts.

.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for 
.I MPI_WTIME
and 
.I MPI_WTICK
) have
an additional argument 
.I ierr
at the end of the argument list.  
.I ierr
is an integer and has the same meaning as the return value of the routine
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.

All MPI objects (e.g., 
.I MPI_Datatype
, 
.I MPI_Comm
) are of type 
.I INTEGER
in Fortran.
The 
.I attribute_val
in Fortran is a pointer to a Fortran integer, not
a pointer to a 
.I void *
\&.


.SH ERRORS

All MPI routines (except 
.I MPI_Wtime
and 
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument.  Before the value is returned, the current MPI error handler is
called.  By default, this error handler aborts the MPI job.  The error handler
may be changed with 
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and 
.I MPI_Win_set_errhandler
(for
RMA windows).  The MPI-1 routine 
.I MPI_Errhandler_set
may be used but
its use is deprecated.  The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does 
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.

.PD 0
.TP
.B MPI_SUCCESS 
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG 
- Invalid argument.  Some argument is invalid and is not
identified by a specific error class (e.g., 
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_KEYVAL 
- Invalid keyval
.PD 1
.PD 0
.TP
.B MPI_ERR_WIN 
- Invalid MPI window object
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER 
- Other error; use 
.I MPI_Error_string
to get more information
about this error code. 
.PD 1

